Azure Schema Registry (stable:2023-07-01)

2025/08/29 • 6 new methods

ListSchemaGroups (new)
Description :  Gets the list of schema groups user is authorized to access.
Reference :  Link ¶

⚼ Request

GET:  /$schemaGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Value:
{
Description: The collection of pageable schema group name items. ,
Required: True ,
}
[
string ,
]
,
NextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetSchemaPropertiesByContent (new)
Description :  Gets the properties referencing an existing schema within the specified schema group, as matched by schema content comparison.
Reference :  Link ¶

⚼ Request

POST:  /$schemaGroups/{groupName}/schemas/{schemaName}:get-id
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupName:
{
Description: Name of schema group. ,
Required: True ,
}
string ,
schemaName:
{
Description: Name of schema. ,
Required: True ,
}
string ,
schemaContent:
{
Description: String representation (UTF-8) of the schema. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
location:
{
Description: URL location of schema, identified by schema group, schema name, and version. ,
}
string ,
schema-group-name:
{
Description: References schema group. ,
}
string ,
schema-id:
{
Description: References specific schema in registry namespace. ,
}
string ,
schema-id-location:
{
Description: URL location of schema, identified by schema ID. ,
}
string ,
schema-name:
{
Description: References schema name. ,
}
string ,
schema-version:
{
Description: Version of the returned schema. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
RegisterSchema (new)
Description :  Register new schema. If schema of specified name does not exist in specified group, schema is created at version 1. If schema of specified name exists already in specified group, schema is created at latest version + 1.
Reference :  Link ¶

⚼ Request

PUT:  /$schemaGroups/{groupName}/schemas/{schemaName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupName:
{
Description: Name of schema group. ,
Required: True ,
}
string ,
schemaName:
{
Description: Name of schema. ,
Required: True ,
}
string ,
schemaContent:
{
Description: String representation (UTF-8) of the schema. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
location:
{
Description: URL location of schema, identified by schema group, schema name, and version. ,
}
string ,
schema-group-name:
{
Description: References schema group. ,
}
string ,
schema-id:
{
Description: References specific schema in registry namespace. ,
}
string ,
schema-id-location:
{
Description: URL location of schema, identified by schema ID. ,
}
string ,
schema-name:
{
Description: References schema name. ,
}
string ,
schema-version:
{
Description: Version of the returned schema. ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListSchemaVersions (new)
Description :  Gets the list of all versions of one schema.
Reference :  Link ¶

⚼ Request

GET:  /$schemaGroups/{groupName}/schemas/{schemaName}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupName:
{
Description: Name of schema group. ,
Required: True ,
}
string ,
schemaName:
{
Description: Name of schema. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Value:
{
Description: The collection of schema version pageable items. ,
Required: True ,
}
[
integer ,
]
,
NextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetSchemaByVersion (new)
Description :  Gets one specific version of one schema.
Reference :  Link ¶

⚼ Request

GET:  /$schemaGroups/{groupName}/schemas/{schemaName}/versions/{schemaVersion}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupName:
{
Description: Name of schema group. ,
Required: True ,
}
string ,
schemaName:
{
Description: Name of schema. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: Version number of specific schema. ,
Format: int32 ,
Required: True ,
}
integer ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: URL location of schema, identified by schema group, schema name, and version. ,
}
string ,
schema-group-name:
{
Description: References schema group. ,
}
string ,
schema-id:
{
Description: References specific schema in registry namespace. ,
}
string ,
schema-id-location:
{
Description: URL location of schema, identified by schema ID. ,
}
string ,
schema-name:
{
Description: References schema name. ,
}
string ,
schema-version:
{
Description: Version of the returned schema. ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetSchemaById (new)
Description :  Gets a registered schema by its unique ID. Azure Schema Registry guarantees that ID is unique within a namespace. Operation response type is based on serialization of schema requested.
Reference :  Link ¶

⚼ Request

GET:  /$schemaGroups/$schemas/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Schema ID that uniquely identifies a schema in the registry namespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: URL location of schema, identified by schema group, schema name, and version. ,
}
string ,
schema-group-name:
{
Description: References schema group. ,
}
string ,
schema-id:
{
Description: References specific schema in registry namespace. ,
}
string ,
schema-id-location:
{
Description: URL location of schema, identified by schema ID. ,
}
string ,
schema-name:
{
Description: References schema name. ,
}
string ,
schema-version:
{
Description: Version of the returned schema. ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}